<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GrPPI: stencil.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.svg"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GrPPI
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">Generic and Reusable Parallel Pattern Interface</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">stencil.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="stencil_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright 2018 Universidad Carlos III de Madrid</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *     http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * limitations under the License.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#ifndef GRPPI_STENCIL_H </span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#define GRPPI_STENCIL_H</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &lt;tuple&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="execution__traits_8h.html">common/execution_traits.h</a>&quot;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="iterator__traits_8h.html">common/iterator_traits.h</a>&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrppi.html">grppi</a> {</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Execution, <span class="keyword">typename</span> ...InputIterators, <span class="keyword">typename</span> OutputIt,</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;          <span class="keyword">typename</span> StencilTransformer, <span class="keyword">typename</span> Neighbourhood,</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;          <a class="code" href="namespacegrppi.html#a53d88980f8164547717a94058db08f94">requires_iterators</a>&lt;InputIterators...&gt; = 0,</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;          requires_iterator&lt;OutputIt&gt; = 0&gt;</div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="group__stencil__pattern.html#gad8e95af475249d066e96b2376f0dc59e">   54</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__stencil__pattern.html#gad8e95af475249d066e96b2376f0dc59e">stencil</a>(</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    <span class="keyword">const</span> Execution &amp; ex,</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    std::tuple&lt;InputIterators...&gt; firsts, std::size_t size, OutputIt out,</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    StencilTransformer &amp;&amp; transform_op,</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    Neighbourhood &amp;&amp; neighbour_op)</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;{</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;  static_assert(supports_stencil&lt;Execution&gt;(),</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;                <span class="stringliteral">&quot;stencil not supported for execution type&quot;</span>);</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;  ex.stencil(firsts, out, size,</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;             std::forward&lt;StencilTransformer&gt;(transform_op),</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;             std::forward&lt;Neighbourhood&gt;(neighbour_op));</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;}</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Execution, <span class="keyword">typename</span> ...InputIterators,</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;          <span class="keyword">typename</span> InputIt, <span class="keyword">typename</span> OutputIt,</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;          <span class="keyword">typename</span> StencilTransformer, <span class="keyword">typename</span> Neighbourhood,</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;          <a class="code" href="namespacegrppi.html#a53d88980f8164547717a94058db08f94">requires_iterators</a>&lt;InputIterators...&gt; = 0,</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;          requires_iterator&lt;InputIt&gt; = 0,</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;          requires_iterator&lt;OutputIt&gt; = 0&gt;</div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="group__stencil__pattern.html#gadbb0797384a9b1320cd55fae732da4a7">   89</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__stencil__pattern.html#gad8e95af475249d066e96b2376f0dc59e">stencil</a>(</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    <span class="keyword">const</span> Execution &amp; ex,</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    std::tuple&lt;InputIterators...&gt; firsts, InputIt last, OutputIt out,</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    StencilTransformer &amp;&amp; transform_op,</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    Neighbourhood &amp;&amp; neighbour_op)</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;{</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;  static_assert(supports_stencil&lt;Execution&gt;(),</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;                <span class="stringliteral">&quot;stencil not supported for execution type&quot;</span>);</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;  ex.stencil(firsts, out,</div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;             std::distance(std::get&lt;0&gt;(firsts),last),</div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;             std::forward&lt;StencilTransformer&gt;(transform_op),</div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;             std::forward&lt;Neighbourhood&gt;(neighbour_op));</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;}</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160; </div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Execution, <span class="keyword">typename</span> InputIt, <span class="keyword">typename</span> OutputIt, </div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;          <span class="keyword">typename</span> StencilTransformer, <span class="keyword">typename</span> Neighbourhood,</div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;          requires_iterator&lt;InputIt&gt; = 0,</div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;          requires_iterator&lt;OutputIt&gt; = 0&gt;</div>
<div class="line"><a name="l00122"></a><span class="lineno"><a class="line" href="group__stencil__pattern.html#gafdf7c38707651f76685eaeed065c2e2c">  122</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__stencil__pattern.html#gad8e95af475249d066e96b2376f0dc59e">stencil</a>(</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;    <span class="keyword">const</span> Execution &amp; ex, </div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;    InputIt first, InputIt last, OutputIt out, </div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;    StencilTransformer &amp;&amp; transform_op, </div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;    Neighbourhood &amp;&amp; neighbour_op) </div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;{</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;  static_assert(supports_stencil&lt;Execution&gt;(),</div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;      <span class="stringliteral">&quot;stencil not supported for execution type&quot;</span>);</div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;  ex.stencil(std::make_tuple(first), out,</div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;      std::distance(first,last),</div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;      std::forward&lt;StencilTransformer&gt;(transform_op),</div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;      std::forward&lt;Neighbourhood&gt;(neighbour_op));</div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;}</div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160; </div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Execution, <span class="keyword">typename</span> InputIt, <span class="keyword">typename</span> OutputIt, </div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;          <span class="keyword">typename</span> StencilTransformer, <span class="keyword">typename</span> Neighbourhood, </div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;          <span class="keyword">typename</span> ... OtherInputIts,</div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;          requires_iterator&lt;InputIt&gt; = 0,</div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;          requires_iterator&lt;OutputIt&gt; = 0&gt;</div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;[[deprecated(<span class="stringliteral">&quot;This version of the interface is deprecated.\n&quot;</span></div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;             <span class="stringliteral">&quot;If you want to use multiple inputs, use a tuple instead.&quot;</span>)]]</div>
<div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="group__stencil__pattern.html#ga45f6f80fb550e49892d84516af52aa0c">  160</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__stencil__pattern.html#gad8e95af475249d066e96b2376f0dc59e">stencil</a>(</div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;    <span class="keyword">const</span> Execution &amp; ex, </div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;    InputIt first, InputIt last, OutputIt out, </div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;    StencilTransformer &amp;&amp; transform_op, </div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;    Neighbourhood &amp;&amp; neighbour_op, </div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;    OtherInputIts ... other_firsts) </div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;{</div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;  static_assert(supports_stencil&lt;Execution&gt;(),</div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;      <span class="stringliteral">&quot;stencil not supported for execution type&quot;</span>);</div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;  ex.stencil(std::make_tuple(first,other_firsts...), out,</div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;      std::distance(first,last),</div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;      std::forward&lt;StencilTransformer&gt;(transform_op),</div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;      std::forward&lt;Neighbourhood&gt;(neighbour_op));</div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;}</div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160; </div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;}</div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160; </div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aexecution__traits_8h_html"><div class="ttname"><a href="execution__traits_8h.html">execution_traits.h</a></div></div>
<div class="ttc" id="agroup__stencil__pattern_html_gad8e95af475249d066e96b2376f0dc59e"><div class="ttname"><a href="group__stencil__pattern.html#gad8e95af475249d066e96b2376f0dc59e">grppi::stencil</a></div><div class="ttdeci">void stencil(const Execution &amp;ex, std::tuple&lt; InputIterators... &gt; firsts, std::size_t size, OutputIt out, StencilTransformer &amp;&amp;transform_op, Neighbourhood &amp;&amp;neighbour_op)</div><div class="ttdoc">Invoke Stencil pattern on a data sequence with sequential execution.</div><div class="ttdef"><b>Definition:</b> stencil.h:54</div></div>
<div class="ttc" id="aiterator__traits_8h_html"><div class="ttname"><a href="iterator__traits_8h.html">iterator_traits.h</a></div></div>
<div class="ttc" id="anamespacegrppi_html"><div class="ttname"><a href="namespacegrppi.html">grppi</a></div><div class="ttdef"><b>Definition:</b> callable_traits.h:21</div></div>
<div class="ttc" id="anamespacegrppi_html_a53d88980f8164547717a94058db08f94"><div class="ttname"><a href="namespacegrppi.html#a53d88980f8164547717a94058db08f94">grppi::requires_iterators</a></div><div class="ttdeci">std::enable_if_t&lt; are_iterators&lt; T... &gt;, int &gt; requires_iterators</div><div class="ttdef"><b>Definition:</b> iterator_traits.h:59</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2
</small></address>
</body>
</html>
